Group CSV Files

Configuring and Editing Group CSV Files

Once your group .csv files have been created, the next step of the process is to configure and edit the files to prepare them for the subsequent step, where you will import the files into FMS.

The two group .csv files generated, the group definition file and the group entries file, can be configured with the appropriate columns and edited for accuracy and completeness prior to import into FMS.

To Configure and Edit Group Definition CSV Files for Import to FMS

Open the group definition .csv file you created.

Insert required (as noted) columns into your file, using your .csv editor. All group definition .csv columns are listed in a table below.

Insert additional desired columns into your file.

Edit any export items desired (e.g. description, etc.) at this time, in preparation for importing the file to FMS.

Save and then Close the group definition .csv file when you are done, so that the prepared file can be accessed in the subsequent step.

To Configure and Edit Group Entries CSV Files for Import to FMS

Open the group entries .csv file you created.

Insert required (as noted) columns into your file, using your .csv editor. All group entries .csv columns are listed in a table below.

Insert additional desired columns into your file.

Edit any export items desired (e.g. description, etc.) at this time, in preparation for importing the file to FMS.

Save and then Close the group entries .csv file when you are done, so that the prepared file can be accessed in the subsequent step.

Group Definition CSV Columns

The following list contains all available columns that can appear for FMS group definition import .csv files. Required fields are indicated in the table.

Column	Description
GroupName	Input from GMR: The group name. Note: Numeric names will be prefixed with a tilde (~) during file migration, to prevent dropped characters. The tilde will not appear after import to FMS. Valid characters for names are as follows. A-Z, a-z, 0-9, . (period), #, $, &, (, ), +, -, \, /, :, <, >, =, @, [, ], ^, {, }, _ (underscore), !, ~ (tilde). Spaces are acceptable, when they are not leading or trailing. This field is required.
ID	Input from FMS: For all Nodes, this field contains the Node ID. This column is required to be present and have a value in order to change existing FMS Node Group-name values. If present, this column is required to be blank (no value) in order to create a new FMS Node upon import.
FmsExportStatus	The value for this field is generated at export from FMS to the .csv file. Results displayed include the following. OK — Export was successful. Error: X — Export failed due to an error, where X represents the field and the reason for the error. This lets you reconfigure or edit the identified field before attempting the export again. See Exporting FMS Groups to CSV Files for more information.
FmsImportStatus	The value for this field is generated at import into FMS. Results displayed include the following. OK — Import was successful. Error: X — Import failed due to an error, where X represents the field and the reason for the error. This lets you reconfigure or edit the identified field before attempting the import again. See Importing Group CSV Files into FMS for more information.
NodeType	User input: For all group Nodes, enter the group type. Options are as follows. 4 or General = General Group 5 or Physical Station = Physical Station Group (contains gas devices) 6 or Virtual Station = Virtual Station Group (contains other stations or liquid devices) Note: A "balance group" exported from GMR will be imported into FMS as a "virtual station group" type. This field is required.
Description	Input from GMR: The group description. This field is optional.
Category	Input from GMR: If the category from GMR does not exist in FMS, the category will be auto-created and assigned when importing into FMS. This field is optional.
SortPriority	User input: Enter a sort priority number to assign to the group. The priority number assigned places it within a manually sortable list. Higher numbers place a Node higher up on a list. The default value is 0 when exporting from GMR. This field is optional.
SecurityApplication	Input from GMR: The name of the CygNet security application against which GMR security events for the group are authorized. This is generally GMR, unless the system was customized during setup. This field is optional.
BeginActiveUtc	User input: Enter the UTC time for the group Node to begin being active. Note: Leaving this field blank will default to Indefinite (no begin DateTime). This field is optional.
EndActiveUtc	User input: Enter the UTC time for the group Node to stop being active. Note: Leaving this field blank will default to Indefinite (no end DateTime). This field is optional.
GeneralUniqueType	User input: For a General Group Node, if a uniqueness type is selected, enter the type. Options are as follows. 0 or None or <blank> = None 1 or Validation = Validation Engine 2 or Estimation = Estimation Engine 3 or Station Balance = Station Balance 4 or Comp Split = Composition Split Default uniqueness type = None This field is optional.
StationType	User input: For a Station Group Node, enter the station type value. Options are as follows. 0 or Custody = Custody 1 or Check = Check 2 or Interconnect = Interconnect 3 or Line Pack = Line Pack 4 or Gas Loss = Gas Loss 5 or Other = Other 6 or Virtual = Virtual (if the group is the top level of a virtual station group. The station type must also match the group type.) Note: A "balance group" exported from GMR will be imported into FMS as a "virtual station group" type. This field is required for a station group.
StationContribution	User input: For a Station Group Node, enter the station contribution value for the group. Options are as follows. 0 or [+] = Receipt (+) 1 or [-] = Delivery (-) This field is required for a station group.
LinkedStationNodeID	User input: For a Station Group Node, enter the Node ID, in numerical form, of a station to which to link for validation purposes. This field is optional.
ReportingSiteService	User input: For a Station Group Node, enter the Site.Service of the service reporting data for the group. This field is optional.
ReportingFacilityId	User input: For a Station Group Node, enter the FacilityId of the facility reporting data for the group. This field is optional.
StationBaseSync	User input: For a Station Group Node, enter whether or not to auto-synchronize the base conditions with the base run. Options are Y (auto-sync base conditions with base run) or N (manually select base conditions). The recommended setting is Y. This field is required for a station group.
StationBaseTemp	User input: If StationBaseSync = Y, this field will be blank. If StationBaseSync = N, enter the base temperature. Default temperature units = F. This field is required for a station group where StationBaseSync = N.
StationBasePressure	User input: If StationBaseSync = Y, this field will be blank. If StationBaseSync = N, enter the base pressure. Default pressure units = psi. This field is required for a station group where StationBaseSync = N.
StationBaseFpvMethod	User input: If StationBaseSync = Y, this field will be blank (None). If StationBaseSync = N, enter the base FPV calculation method. Options are as follows. 1 or AGA8 Gross 1 = AGA 8 - Gross Method 1 2 or AGA8 Gross 2 = AGA 8 - Gross Method 2 3 or AGA8 Detailed = AGA 8 - Detailed 4 or NX19 GCN = NX 19 GCN Method 5 or NX19 Complete = NX 19 Complete 6 or None or <blank> = None This field is required for a station group where StationBaseSync = N.
ContractHour	User input: For a Station Group Node, enter the number (in hours) of the contract offset. This number is an offset (in hours) from the 00:00:00 (midnight) Device time, describing the hour at which the contract day begins. This field is required for a station group.
TimezoneKey	User input: For a Station Group Node, enter a numerical value for the CygNet time zone key. This information is contained in the CygNetTimeZones.xml file located in the CygNet\Services\ARS folder on your host server. See CygNetTimeZones.xml File for more information. This field is required for a station group.
TimezoneDst	User input: For a Station Group Node, enter a value for time zone DST. Options are as follows. Y = Daylight Saving Time enabled N = Daylight Saving Time not enabled This field is required for a station group.

Column

Description

GroupName

Input from GMR: The group name.

Note: Numeric names will be prefixed with a tilde (~) during file migration, to prevent dropped characters. The tilde will not appear after import to FMS.

Valid characters for names are as follows.

A-Z, a-z, 0-9, . (period), #, $, &, (, ), +, -, \, /, :, <, >, =, @, [, ], ^, {, }, _ (underscore), !, ~ (tilde). Spaces are acceptable, when they are not leading or trailing.

This field is required.

Input from FMS: For all Nodes, this field contains the Node ID.

This column is required to be present and have a value in order to change existing FMS Node Group-name values.
If present, this column is required to be blank (no value) in order to create a new FMS Node upon import.

FmsExportStatus

The value for this field is generated at export from FMS to the .csv file.

Results displayed include the following.

OK — Export was successful.
Error: X — Export failed due to an error, where X represents the field and the reason for the error. This lets you reconfigure or edit the identified field before attempting the export again.

See Exporting FMS Groups to CSV Files for more information.

FmsImportStatus

The value for this field is generated at import into FMS.

Results displayed include the following.

OK — Import was successful.
Error: X — Import failed due to an error, where X represents the field and the reason for the error. This lets you reconfigure or edit the identified field before attempting the import again.

See Importing Group CSV Files into FMS for more information.

NodeType

User input: For all group Nodes, enter the group type.

Options are as follows.

4 or General = General Group
5 or Physical Station = Physical Station Group (contains gas devices)
6 or Virtual Station = Virtual Station Group (contains other stations or liquid devices)

Note: A "balance group" exported from GMR will be imported into FMS as a "virtual station group" type.

This field is required.

Description

Input from GMR: The group description.

This field is optional.

Category

Input from GMR: If the category from GMR does not exist in FMS, the category will be auto-created and assigned when importing into FMS.

This field is optional.

SortPriority

User input: Enter a sort priority number to assign to the group. The priority number assigned places it within a manually sortable list. Higher numbers place a Node higher up on a list.

The default value is 0 when exporting from GMR.

This field is optional.

SecurityApplication

Input from GMR: The name of the CygNet security application against which GMR security events for the group are authorized.

This is generally GMR, unless the system was customized during setup.

This field is optional.

BeginActiveUtc

User input: Enter the UTC time for the group Node to begin being active.

Note: Leaving this field blank will default to Indefinite (no begin DateTime).

This field is optional.

EndActiveUtc

User input: Enter the UTC time for the group Node to stop being active.

Note: Leaving this field blank will default to Indefinite (no end DateTime).

This field is optional.

GeneralUniqueType

User input: For a General Group Node, if a uniqueness type is selected, enter the type. Options are as follows.

0 or None or <blank> = None
1 or Validation = Validation Engine
2 or Estimation = Estimation Engine
3 or Station Balance = Station Balance
4 or Comp Split = Composition Split

Default uniqueness type = None

This field is optional.

StationType

User input: For a Station Group Node, enter the station type value.

Options are as follows.

0 or Custody = Custody
1 or Check = Check
2 or Interconnect = Interconnect
3 or Line Pack = Line Pack
4 or Gas Loss = Gas Loss
5 or Other = Other
6 or Virtual = Virtual (if the group is the top level of a virtual station group. The station type must also match the group type.)

Note: A "balance group" exported from GMR will be imported into FMS as a "virtual station group" type.

This field is required for a station group.

StationContribution

User input: For a Station Group Node, enter the station contribution value for the group.

Options are as follows.

0 or [+] = Receipt (+)
1 or [-] = Delivery (-)

This field is required for a station group.

LinkedStationNodeID

User input: For a Station Group Node, enter the Node ID, in numerical form, of a station to which to link for validation purposes.

This field is optional.

ReportingSiteService

User input: For a Station Group Node, enter the Site.Service of the service reporting data for the group.

This field is optional.

ReportingFacilityId

User input: For a Station Group Node, enter the FacilityId of the facility reporting data for the group.

This field is optional.

StationBaseSync

User input: For a Station Group Node, enter whether or not to auto-synchronize the base conditions with the base run. Options are Y (auto-sync base conditions with base run) or N (manually select base conditions). The recommended setting is Y.

This field is required for a station group.

StationBaseTemp

User input: If StationBaseSync = Y, this field will be blank. If StationBaseSync = N, enter the base temperature.

Default temperature units = F.

This field is required for a station group where StationBaseSync = N.

StationBasePressure

User input: If StationBaseSync = Y, this field will be blank. If StationBaseSync = N, enter the base pressure.

Default pressure units = psi.

This field is required for a station group where StationBaseSync = N.

StationBaseFpvMethod

User input: If StationBaseSync = Y, this field will be blank (None).

If StationBaseSync = N, enter the base FPV calculation method. Options are as follows.

1 or AGA8 Gross 1 = AGA 8 - Gross Method 1
2 or AGA8 Gross 2 = AGA 8 - Gross Method 2
3 or AGA8 Detailed = AGA 8 - Detailed
4 or NX19 GCN = NX 19 GCN Method
5 or NX19 Complete = NX 19 Complete
6 or None or <blank> = None

This field is required for a station group where StationBaseSync = N.

ContractHour

User input: For a Station Group Node, enter the number (in hours) of the contract offset.

This number is an offset (in hours) from the 00:00:00 (midnight) Device time, describing the hour at which the contract day begins.

This field is required for a station group.

TimezoneKey

User input: For a Station Group Node, enter a numerical value for the CygNet time zone key. This information is contained in the CygNetTimeZones.xml file located in the CygNet\Services\ARS folder on your host server.

See CygNetTimeZones.xml File for more information.

This field is required for a station group.

TimezoneDst

User input: For a Station Group Node, enter a value for time zone DST. Options are as follows.

Y = Daylight Saving Time enabled

N = Daylight Saving Time not enabled

This field is required for a station group.

Group Entries CSV Columns

The following list contains all available columns that can appear for FMS group entries import .csv files. Required fields are indicated in the table.

Column	Description
MemberNode	Input from GMR: The member name. Note: Numeric names will be prefixed with a tilde (~) during file migration, to prevent dropped characters. The tilde will not appear after import to FMS. Valid characters for names are as follows. A-Z, a-z, 0-9, . (period), #, $, &, (, ), +, -, \, /, :, <, >, =, @, [, ], ^, {, }, _ (underscore), !, ~ (tilde). Spaces are acceptable, when they are not leading or trailing. This field is required.
GroupName	Input from GMR: The group name. Note: Numeric names will be prefixed with a tilde (~) during file migration, to prevent dropped characters. The tilde will not appear after import to FMS. Valid characters for names are as follows. A-Z, a-z, 0-9, . (period), #, $, &, (, ), +, -, \, /, :, <, >, =, @, [, ], ^, {, }, _ (underscore), !, ~ (tilde). Spaces are acceptable, when they are not leading or trailing. This field is required.
FmsExportStatus	The value for this field is generated at export from FMS to the .csv file. Results displayed include the following. OK — Export was successful. Error: X — Export failed due to an error, where X represents the field and the reason for the error. This lets you reconfigure or edit the identified field before attempting the export again. See Exporting FMS Groups to CSV Files for more information.
FmsImportStatus	The value for this field is generated at import into FMS. Results displayed include the following. OK — Import was successful. Error: X — Import failed due to an error, where X represents the field and the reason for the error. This lets you reconfigure or edit the identified field before attempting the import again. See Importing Group CSV Files into FMS for more information.
BeginActiveUtc	User input: For all group Nodes, enter the UTC time for the Node to begin being active. Note: Leaving this field blank will default to Indefinite (no begin DateTime). This field is optional.
EndActiveUtc	User input: For all group Nodes, enter the UTC time for the Node to stop being active. Note: Leaving this field blank will default to Indefinite (no end DateTime). This field is optional.
StationIsBaseRun	User input: For members of a physical Station Group Node, enter whether the run to which the member Node belongs is the base run or not. Options are as follows. Y = Node is base run N = Node is not base run Note: This value must equal Y for all Nodes that are members of the base run. This field is required for members of a physical station group.
StationRunOrdinal	User input: For members of a physical Station Group Node, enter the unique ordinal number associated with the run to which the member Node belongs. Acceptable values are 1 to 99. This field is required for members of a physical station group.
StationPriorityOnRun	User input: For members of a physical Station Group Node, enter the unique ordinal number associated with the priority of the member Node within the run to which it belongs. Acceptable values are 1 to 99. This field is required for members of a physical station group.
PercentOfBaseRun	User input: For members of a physical Station Group Node, that are not the base run (StationIsBaseRun = N), enter a value, expressed as a numerical percentage, to indicate the run's expected flow as a percentage of the base run. Acceptable values are between 0 and 100, with up to 7 significant digits. Note: Leaving this field blank will default to a value of 0. This field is required for members of a physical station group, that are not in the base run.
StationContribution	User input: For a group entry station Node (Station Group or Station Meter), enter the station contribution value for the group entry Node. Options are as follows. 0 or [+] — Receipt (+) 1 or [-] — Delivery (-) This field is required for a station group entry. Note: Leaving this field blank for a station group entry that is a station meter Node, will default to a value of 0 Receipt (+), not the value configured in the Node properties.

Column

Description

MemberNode

Input from GMR: The member name.

Note: Numeric names will be prefixed with a tilde (~) during file migration, to prevent dropped characters. The tilde will not appear after import to FMS.

Valid characters for names are as follows.

A-Z, a-z, 0-9, . (period), #, $, &, (, ), +, -, \, /, :, <, >, =, @, [, ], ^, {, }, _ (underscore), !, ~ (tilde). Spaces are acceptable, when they are not leading or trailing.

This field is required.

GroupName

Input from GMR: The group name.

Note: Numeric names will be prefixed with a tilde (~) during file migration, to prevent dropped characters. The tilde will not appear after import to FMS.

Valid characters for names are as follows.

A-Z, a-z, 0-9, . (period), #, $, &, (, ), +, -, \, /, :, <, >, =, @, [, ], ^, {, }, _ (underscore), !, ~ (tilde). Spaces are acceptable, when they are not leading or trailing.

This field is required.

FmsExportStatus

The value for this field is generated at export from FMS to the .csv file.

Results displayed include the following.

OK — Export was successful.
Error: X — Export failed due to an error, where X represents the field and the reason for the error. This lets you reconfigure or edit the identified field before attempting the export again.

See Exporting FMS Groups to CSV Files for more information.

FmsImportStatus

The value for this field is generated at import into FMS.

Results displayed include the following.

OK — Import was successful.
Error: X — Import failed due to an error, where X represents the field and the reason for the error. This lets you reconfigure or edit the identified field before attempting the import again.

See Importing Group CSV Files into FMS for more information.

BeginActiveUtc

User input: For all group Nodes, enter the UTC time for the Node to begin being active.

Note: Leaving this field blank will default to Indefinite (no begin DateTime).

This field is optional.

EndActiveUtc

User input: For all group Nodes, enter the UTC time for the Node to stop being active.

Note: Leaving this field blank will default to Indefinite (no end DateTime).

This field is optional.

StationIsBaseRun

User input: For members of a physical Station Group Node, enter whether the run to which the member Node belongs is the base run or not.

Options are as follows.

Y = Node is base run

N = Node is not base run

Note: This value must equal Y for all Nodes that are members of the base run.

This field is required for members of a physical station group.

StationRunOrdinal

User input: For members of a physical Station Group Node, enter the unique ordinal number associated with the run to which the member Node belongs. Acceptable values are 1 to 99.

This field is required for members of a physical station group.

StationPriorityOnRun

User input: For members of a physical Station Group Node, enter the unique ordinal number associated with the priority of the member Node within the run to which it belongs. Acceptable values are 1 to 99.

This field is required for members of a physical station group.

PercentOfBaseRun

User input: For members of a physical Station Group Node, that are not the base run (StationIsBaseRun = N), enter a value, expressed as a numerical percentage, to indicate the run's expected flow as a percentage of the base run. Acceptable values are between 0 and 100, with up to 7 significant digits.

Note: Leaving this field blank will default to a value of 0.

This field is required for members of a physical station group, that are not in the base run.

StationContribution

User input: For a group entry station Node (Station Group or Station Meter), enter the station contribution value for the group entry Node.

Options are as follows.

0 or [+] — Receipt (+)
1 or [-] — Delivery (-)

This field is required for a station group entry.

Note: Leaving this field blank for a station group entry that is a station meter Node, will default to a value of 0 Receipt (+), not the value configured in the Node properties.